Asynchronous notification

If the notifyUrl parameter is passed in the transfer to bank request to receive notifications, PayBy will send a message to the address when when the order status changes from CREATED to SUCCESS or FAILURE.

Notice

1. In this scenario, the request is sent by PayBy to the merchant, and the merchant needs to send response to PayBy.
2. After receiving the notification, please return the success message, otherwise PayBy will try to send multiple times. The maximum number of attempts is 7. The interval time between each attempt is as follows: 2 minutes, 10 minutes, 10 minutes, 1 hour, 2 hours, 6 hours, and 15 hours.
3. The notification request is signed by payBy side. The merchant must verify the notification signature before processing the content.

Request

Http Header

---

Attributes

Content-Type String Required

The media type. Required for operations with a request body. The value is application/<format>, where format is json.

Example value: application/json

sign String Required

When PayBy sends response, PayBy will use its own private key to sign the message, and the merchant uses PayBy 's public key to verify the signature. If the verification is passed, it proves that the response was sent by PayBy and not faked by others.

Http Body

---

notify_timestamp Timestamp Required

The timestamp when PayBy sent the request.

Example value: 1586849271877

notify_id String Required

The unique identification number of this notification within the PayBy system.

Example value: 202004140007474501

• transferToBankOrder Object

  Attributes

  • merchantOrderNo String Required

    The merchant's reference number of the request. Used to track every request.

    Example value: M965739182419

    Maximum length: 64

    
    

  • orderNo String Required

    The merchant's reference number of the request. Used to track every request.

    Example value: M965739182419

    Maximum length: 64

    
    

  • holderName String Required

    The holder name of the beneficiary account. The parameter needs to be encrypted when passed, and SHA-256 algorithm is recommended.

    Maximum length: 100

    
    

  • iban String

    The IBAN number of the beneficiary account. The parameter needs to be encrypted when passed, and SHA-256 algorithm is recommended.

    Maximum length: 34

    
    

  • swiftCode String

    A SWIFT code consists of 8-11 characters and follows a format that identifies the benificiary account's bank, country, location, and branch.

    Maximum length: 11

    
    

  • beneficiaryAddress String Required

    1. If the beneficiary account is a personal account, the beneficiary address must be passed, and the sum of the characters of the two values of holderName and beneficiaryAddress cannot exceed 140, otherwise the transfer may fail.

    2. Only the following characters are allowed to pass, if the parameter contains other characters, the response will be error: a - z A - Z 0 - 9 / . -

    3. The parameter needs to be encrypted when passed, and SHA-256 algorithm is recommended.

       Example value: Liwa Street off Khalifa Street

       Maximum length: 140

    Example value: Liwa Street off Khalifa Street

    Maximum length: 140

    
    

  • amount Money Required

    How much AED do you want to transfer. The currency code must be AED.

    
    

  • memo String Required

    The description of this transfer.

    Maximum length: 128

    
    

  • notifyUrl String

    To receive asynchronous notifications of order status updates, you can pass the notify URL.

    Example value: https://www.yoursite.com

    Maximum length: 200

    
    

  • accountNo String

    Bank account number of the beneficiary account.

    Example value: 2000000000001

    Maximum length: 64

    
    

  • networkCode String

    The code of which transfer network is used in this payout. The default value is LOCAL.

    Example value: LOCAL, SWIFT

    Maximum length: 20

    
    

  • bankName String

    The bank name of the beneficiary account.

    Example value: First Abu Dhabi Bank PJSC

    Maximum length: 64

    
    

  • countryCode String

    The code of the country where the bank of the beneficiary account belongs. The default value is UAE.

    Example value: UAE, SG, US, etc.

    Maximum length: 16

    
    

  • fundoutCurrencyCode String

    In this payout, the currency of the funds received by the beneficiary account. The default value is AED.

    Example value: AED, USD.

    Maximum length: 16

    
    

  • fedwireCode String

    A Fedwire (or ABA) code is a bank code used in the United States, which identifies financial institutions. Fedwire/ABA codes are always nine (9) digits in length.

    Example value: 133563585

    Maximum length: 9

    
    

  • branchName String

    The branch name of the bank of the beneficiary account.

    Example value: Mall of the Emirates Branch

    Maximum length: 35

    
    

  • intermediaryBank String

    An intermediary bank is required when making international funds transfers between the originator bank and the beneficiary bank. This only happens when the banks don’t have an established relationship, such as an account that would otherwise facilitate a direct deposit in a SWIFT network.

    Example value: iPhone

    Maximum length: 12

    
    

  • beneficiaryType String

    In this payout method, what type of code is used to identify the beneficiary account or the bank to which the beneficiary account belongs.

    Example value: IBAN, BBAN.

    Maximum length: 16

    
    

**notify_time** String

The parameter is deprecated. Please use the notify_timestamp instead.

**_input_charset** String

The parameter is deprecated.

Notification sample

Http Header
{
    "Content-Type": "application/json; charset=UTF-8"
}

Http Body
{
    "_input_charset": "UTF-8",
    "notify_id": "202004140007474501",
    "notify_time": "20200414113800",
    "transferToBankOrder": {
        "amount": {
            "amount": 0.02,
            "currency": "AED"
        },
        "holderName": "00d74f270d2251e8fa6e7f3b1ea06bd3b5f32dfe4719f9df60982c55b24e4898",
        "iban": "1fc44f25c178c422f705054c669cfa6133f6dc8e1fe24b3d96f847667db8b92c",
        "memo": "company single pay",
        "merchantOrderNo": "M188573109026",
        "notifyUrl": "http://www.yoursite.com",
        "orderNo": "911586849271010217",
        "paymentInfo": {
            "arrivalTime": 1586849273000,
            "payerFeeAmount": {
                "amount": 5.0,
                "currency": "D"
            }
        },
        "product": "Transfer To Bank",
        "requestTime": 1586849271877,
        "status": "SUCCESS",
        "swiftCode": "BBME AEAD"
    }
}

Response

Please reply success after receiving the notification, otherwise PayBy will send the notification repeatedly for the same order.

Http Header

---

Content-Type String Required

The media type. Required for operations with a request body. The value is application/<format>, where format is json.

Example value: application/json

Http Body

---

response String Required

Example value: Success

Http Header
{
 "Content-Type": "application/json; charset=UTF-8" 
}

Http Body
{
    "response":"SUCCESS"
}